Moment.js Transform

Wouldn't it be useful to manipulate a date using patterns? Don't you find it annoying to always have to set hours, minutes, seconds and milliseconds to zero to drop the time part of a date? Want to set the configuration of one of your component to YtD or -30 days using a simple string?

Those are the use cases this plugin aims to answer.

Installation

First, download it:

• using Bower: bower install moment-transform
• on the release release page
• by cloning the GitHub repository

Then add the plugin after the moment.js library:

<script src="./lib/moment/moment.min.js"></script>
<script src="./lib/moment-transform/moment-transform.min.js"></script>
    

Usage

This plugin provides one additional method to all Moment instances. Its signature is as follows:

momentInstance.transform(value[, patterns][, strict])
    

Where:

• value is a string that you can expect to be matched by the pattern.
• patterns is an optional parameter. It can either be a string or an array of strings. Those patterns will sequentially be tried on the value. The first one that matches (does not return an invalid date) will be selected. Default value is ['YYYY-MM-DD HH:mm:ss.SSS', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DD', 'HH:mm:ss.SSS', 'HH:mm:ss'].
• strict is an optional boolean parameter. If set to false, any character in a pattern that is not a letter is optional.

In a pattern, each group of the same letter (i.e. YYYY) will match [+-]?\d+. If no sign is present, it will set the value of the corresponding part of the date (i.e. year). If there is a sign, it will add or substract the value to the corresponding part of the date.

More information on the accepted pattern can be found in the format() documentation.

In everycase, the method will return a new Moment instance. If a pattern has been matched, it will return the new date. If none could be match or if the Moment instance was already invalid, it will return an invalid date. This can easily be checked by using the isValid() method.